Schema Changes from V10.0 through V10.10

IMPORTANT - When upgrading, all merchants using V9.x or below should upgrade to V11.x, skipping the V10.x family of releases.

The table below includes elements added in schema versions 10.0 through 10.10.

TABLE 1-8 New Elements in V10.0 through V10.10

New Element	Parent of	Child of	Comments
`queryTransaction`	`origId` `origActionType` `origLitleTxnId` `origOrderId` `origAccountNumber`	`litleOnlineRequest`	You use this transaction type to determine the status of a previously submitted transaction. You can submit this element only as an Online transaction.
`origId`		`queryTransaction`	The `origId` element is a required child of the `queryTransaction` element and defines the id attribute used in the original transaction.
`origActionType`		`queryTransaction`	The `origActionType` element is a required child of the `queryTransaction` element and defines the transaction type of original transaction. Please refer to the Worldpay eComm cnpAPI Reference Guide for a list of the allowed values.
`origLitleTxnId`		`queryTransaction`	The `origLitleTxnId` element is an optional child of the `queryTransaction` element and defines the value of the `litleTxnId` element assigned to the original transaction and returned in the response message.
`origOrderId`		`queryTransaction`	The `origOrderId` element is an optional child of the `queryTransaction` element and defines themerchant-assigned value for the `orderId` element submitted in the original transaction.
`origAccountNumber`		`queryTransaction`	The `origAccountNumber` element is an optional child of the `queryTransaction` element and defines the account number of the credit/debit/gift card used in the original transaction.
`queryTransactionRessponse`	`response` `responseTime` `message` `matchCount` `results_Max10`	`litleOnlineResponse`	The parent element for the response to `queryTransaction` requests.
`matchCount`		`queryTransactionResponse`	The `matchCount` element is a required child of the `queryTransactionResponse` element and defines the number of found transactions that matched the criteria submitted in the `queryTransaction`.
`results_Max10`	`activateResponse` `activateReversalResponse` `authorizationResponse` `captureResponse` `creditResponse` `deactivateResponse` `depositReversalResponse` `echeckCreditResponse` `echeckSalesResponse` `loadResponse` `loadReversalResponse` `refundReversalResponse` `saleResponse` `unloadResponse` `unloadReversalResponse` `voidResponse` `queryTransactionUnavailableResponse`	`queryTransactionResponse`	The `results_Max10` element is a required child of the `queryTransactionResponse`. Any original transaction responses that match the criteria submitted in the `queryTransaction` appear as children of this element in the response. The system can return a maximum of ten responses as children of the `results_Max10` element. The value for the `matchCount` element reflects the number of found transactions. If the system does not find any transactions matching the query criteria, the `results_Max10` element will be empty. If the query results is a response code of 152 - Transaction found, but response not yet available, the `results_Max10` element will contain at least one `queryTransactionUnavaila bleResponse` child and may contain other found responses.
`cardSuffix`		`authorizationResponse` `saleResponse`	It provides the last four digits of the actual PAN for Apple Pay and Android Pay transactions, when the underlying card is either Visa or MasterCard.
`processingType`		`authorization` `captureGivenAuth` `forceCapture` `sale`	You use this element to define a Visa transaction is intended to fund a host-based prepaid product, a brokerage account, or an escrow account.
`adroidpayResponse`	`cryptogram` `expMonth` `expYear`	`authorizationResponse` `registerTokenResponse` `saleResponse`	The `androidpayResponse` element is an optional child of several transaction types and is returned in response messages, when the `orderSource` in the request is `androidpay`.
`cryptogram`		`androidpayResponse`	The `cryptogram` element is an optional child of the `androidpayResponse` element and provides the BASE64 Encoded signature cryptogram associated with the Android Pay transaction.
`expMonth`		`androidpayResponse`	The `expMonth` element is an optional child of the `androidpayResponse` element, which specifies the month of expiration of the network token (format: mm).
`expYear`		`androidpayResponse`	The expYear element is an optional child of the `androidpayResponse` element, which specifies the year of expiration of the network token (format: yyyy).
`customIdendifier`		`payFacCredit` `payFacDebit` `physicalCheckCredit` `physicalCheckDebit` `submerchantCredit` `submerchantDebit` `reserveCredit` `reserveDebit` `VendorCredit` `VendorDebit`	Payment Facilitators can use this element to specify a Billing Descriptor to appear on the bank statements of the parties involved in the funds transfer. The information you provide in this element populates the Individual ID field of the ACH Record. The use of this field and its appearance on bank statements is at the discretion of the bank producing the statement.
`networkResponse`	`endpoint` `networkField`	`enhancedAuthResponse`	Child elements provide a number of data points returned by the card networks in their ISO 8583 response messages.
`endpoint`		`networkResponse`	It defines the card network acting as an endpoint for the submitted transaction.
`networkField`	`fieldValue` `networkSubField`	`networkResponse`	Its attributes and child elements define the Field Number, Field Name, (Raw) Field Value, as well as any Sub-fields, if applicable. Attributes are `fieldName` and `fieldNumber`.
`fieldValue`		`networkField` `networkSubField`	This element provides the raw data for the designated field, extracted from the network ISO 8583 response message.
`networkSubField`	`fieldValue`	`networkField`	This element provides the raw `subfield` data returned by the card networks in their ISO 8583 response messages. Attribute is `fieldNumber`.
`fundingInstructionVoid`	litleTnxId	batchRequest	A transaction type that allows you to void an unsettled Dynamic Payout Funding Instruction.
`fundingInstructionVoidResponse`	`litleTxnId` `fundsTransferId` `response` `responseTime` `message`	`batchResponse`	The response message to a `fundingInstructionVoid` request.
`sepaDirectDebit`	`iban` `mandateProvider` `sequenceType` `mandateReference` `mandateUrl` `mandateSignatureDate` `preferredLanguage`	`sale` (Online only)	This new method of payment allows transactions using the Single Euro Payments Area Direct Debit network.
`iban`		`sepaDirectDebit`	The International Bank Account Number of the consumer.
`mandateProvider`		`sepaDirectDebit`	Defines whether the merchant or Worldpay supplies the mandate.
`sequenceType`		`sepaDirectDebit`	This element defines the purchase in terms of a one-time buy or a member of a recurring stream of debits. Attributes are: OneTime, FirstRecurring, SubsequentRecurring, and FinalRecurring.
`mandateReference`		`sepaDirectDebit` `sepaDirectDebitResponse`	You use this element for recurring payments (after the initial transaction) to provide the reference number that links subsequent payments in a recurring stream to the mandate agreed to at the time of the initial payment. Worldpay returns this value in the `sepaDirectDebitResponse` associated with the initial payment.
`mandateUrl`		`sepaDirectDebit`	This element defines the URL of the mandate to which the consumer agreed, allowing the merchant to debit their account. Although optional, you should always provide this information when the value for the `mandateProvider` element is Merchant.
`mandateSignatureDate`		`sepaDirectDebit`	This element defines the date the consumer agreed to the mandate allowing the merchant to debit their account. Although optional, you should always provide this information when the value for the `mandateProvider` element is Merchant.
`preferredLanguage`		`sepaDirectDebit`	This defines the language in which the merchant prefers the mandate to appear. While the merchant could be able to select any language, the mandate may not be available in the selected language. If the selected language is not available, the mandate appears in English. If you do not include this element, the preferred language defaults to the language indicated by the country of the IBAN, unless it is not available, in which case the language defaults to English.
`sepaDirectDebitResponse`	`mandateReference` `rediredtUrl` `redirectToken`	`saleResponse`	This element, returned for `sepaDirectDebit` transactions, contains child elements you should save for future reference.
`rediredtUrl`		`sepaDirectDebitResponse`	This element defines the URL that hosts the mandate, when Worldpay supplies the mandate. If you supply the mandate (`<mandateProvider>Me rchant</mandateProv ider>`), this element will not appear in the response.
`redirectToken`		`sepaDirectDebitResponse`	This element defines a value you can use to verify the approval of the Mandate by the consumer.
`networkTransactionId`		`authorizationResponse` `saleResponse`	Returned in response messages for Visa, MasterCard, and Discover transactions. Store the value to use in later recurring, installment, or card on file transactions.
`originalNetworkTransactionId`		`authorization` `captureGivenAuth` `sale`	For Visa and Discover, include this element for recurring, installment, and card on file (after initial) transactions.
`originalTransactionAmount`		`authorization` `captureGivenAuth` `sale`	For Discover, include this element for recurring payments (after initial) involving network tokens. Note: Not used at this time.
`eciIndicator`		`adroidpayResponse applepayResponse`	This element was added to the `androidpayResponse` element. It was already a child of `applepayResponse`
`orderId`		`acountUpdateResponse`	This element, which was removed in V10.0, has been added back to the response message.
`foreignRetailerIndicator`		`capture` `captureGivenAuth` `forceCapture` `sale`	Must be present when the marketplace and retailer are not in the same region (country). A value of 'F' indicates that the retailer is located in a different country.
`authIndicator`		`authorization`	Required if you submit an Incremental Authorization, used by certain Travel and Entertainment (T&E) merchants. when final purchase amounts are unknown.

Other schema changes:

The id attribute, which was optional, is now required.
The duplicate attribute, used to indicate a duplicate Online transaction, has been removed. If the system determines a transaction to be a duplicate, The duplicate transactions appears in the Declined Transaction report with a Response Reason Code of 251 - Duplicate Transaction. You can access this report in Worldpay eComm iQ or via the Worldpay eComm Secure Scheduled Report.s The iQ version provides information in near real-time, while the SSR version runs daily, providing information for the transactions submitted the previous day.
The orderId element has been removed from all response messages EXCEPT the Authorization Response and the Sale Response.
There is a new (Online only) transaction type: queryTransaction. The Status Query Transaction allows you to verify that an Online transaction submitted within the prior six hours exists in the system. The response will be one of the following:
- A single transaction matching the search criteria
- Multiple transactions matching the search criteria
- Empty results, if no transactions matched the criteria
- A limited response, if a transaction was found, but processing was not complete
As search criteria, you must submit, at a minimum, the id (id attribute) and transaction type (i.e., authorization, deposit, void, etc.) of the original transaction, but to narrow the search, you can also include the transaction id, order id, and the account number (credit, debit, or gift card) from the original transaction. The response message contains one of four response codes, 150 through 153 (see Payment Transaction Response Codes in the Worldpay eComm cnpAPI Reference Guide), and the results for the search.

Aside from the structural differences noted above, please note that most transactions will return a Reason Code of 001 - Transaction Received in the response messages. You will need to pick up the Declined Transaction Report from SSR, to determine the transactions declined the previous day. This report is also available in Worldpay eComm iQ.

Added new Response Codes, 901 through 905, associated with the SEPA Direct Debit method of payment.
A new enum, VisaCheckout, was added to the walletSourceType element for use when the transaction involves Visa Checkout.
A new enum, androidpay, was added to the orderSource element for use when the transaction involves Android Pay.
Add two new enumerations for processingType element: initialRecurring and initialInstallment. The new enumerations are related to the use of networkTransactionId, originalNetworkTransactionId and originalTransactionAmount elements for Visa transaction involving network tokens.
New enumerations added to the processingType element to support card on file transactions. The new enumerations are: initialCOF, merchantInitiatedCOF, and cardholderInitiatedCOF.
The minLength for routingNum changed from 9 to 8 characters to accommodate some Canadian routing numbers.